// Copyright (c) 2008-2010, Arne Claus
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the 
// following conditions are met:
//
// - Redistributions of source code must retain the above copyright notice, this list of conditions and the following 
//   disclaimer.
// - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following 
//   disclaimer in the documentation and/or other materials provided with the distribution.
// - Neither the name Arne Claus nor the names of any contributors may be used to endorse or promote products
//   derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef __INCLUDED_CBL_RESOURCEPTR_H__
#define __INCLUDED_CBL_RESOURCEPTR_H__

#include "CBL_Defines.h"
#include "CBL_Memory.h"
#include "CBL_Debug.h"
#include <cstdlib>

CB_NAMESPACE_START

//! \note	Provides memory management on copy and delete, meaning the wrapped object will be deleted
//!			if there is no resourceptr left handling the object. Objects must be derived from IResource.
//!			Note: This Pointertype is "safer" than CReferencePtr because the count is kept within
//!			the wrapped object. While CReferencePtr cannot keep track of new pointers created via 
//!			dereferencing another pointer - this class can do it. You should prefer this class over 
//! 		CReferencePtr whenever possible.

// -------------------------------------------------------------------------------------------------
//	CResource
// -------------------------------------------------------------------------------------------------

class IResource
{
public:

	IResource()
		: m_ReferenceCounter(0)
	{
	}    

	void KeepReference() 	 		{ ++m_ReferenceCounter; }
    int32 GetReferenceCount() const	{ return m_ReferenceCounter; }
    
    CB_FORCEINLINE bool CB_INLINE_ATTR ReleaseReference();
		
private:
	
	int32 m_ReferenceCounter;
};


// -------------------------------------------------------------------------------------------------
//	CResourcePtr
// -------------------------------------------------------------------------------------------------

template <typename TType>
class CResourcePtr
{
public:
	
	CResourcePtr();
	
    CResourcePtr(const CResourcePtr<TType>& _rCopy);

	template <typename TType2>
	CResourcePtr(const CResourcePtr<TType2>& _rCopy);

    //! \note Stores a new reference to _pObject but does NOT invalidate the original.
    CResourcePtr(IResource* _pObject);	
        
	~CResourcePtr();
	
public:
	
	CB_FORCEINLINE TType& CB_INLINE_ATTR operator * ()						{ return *static_cast<TType*>(m_pObject); }
	CB_FORCEINLINE TType* CB_INLINE_ATTR operator -> ()						{ return static_cast<TType*>(m_pObject); }
	
	CB_FORCEINLINE const TType& CB_INLINE_ATTR operator * () const			{ return *static_cast<TType*>(m_pObject); }
	CB_FORCEINLINE const TType* CB_INLINE_ATTR operator -> () const			{ return static_cast<TType*>(m_pObject); }
	
	CB_FORCEINLINE TType* CB_INLINE_ATTR GetObject() const					{ return static_cast<TType*>(m_pObject); }
	CB_FORCEINLINE bool CB_INLINE_ATTR IsValid() const						{ return m_pObject != NULL; }
	
	CB_FORCEINLINE int32 CB_INLINE_ATTR GetReferenceCount() const			{ return (m_pObject) ? m_pObject->GetReferenceCount() : 0; }	
	CB_FORCEINLINE bool CB_INLINE_ATTR IsLastReference() const				{ return (m_pObject) ? m_pObject->GetReferenceCount() == 1 : false; }
	
	//! \note Stores a new reference to _pObject but does NOT invalidate the original.
    CB_FORCEINLINE CResourcePtr& CB_INLINE_ATTR operator = (IResource* _pNewObject);
	CB_FORCEINLINE CResourcePtr& CB_INLINE_ATTR operator = (const CResourcePtr<TType>& _rCopy);
    
    template <typename TType2>
    CB_FORCEINLINE CResourcePtr& CB_INLINE_ATTR operator = (const CResourcePtr<TType2>& _rCopy);
	
	CB_FORCEINLINE void CB_INLINE_ATTR Release();
	CB_FORCEINLINE TType* CB_INLINE_ATTR Retain();
	
private:
	
	TType* m_pObject;
};

#include "CBL_ResourcePtr.hpp"

CB_NAMESPACE_END

#endif